SetRowCompressed(byte[],ushort[],int,int,int) Method

Summary

Puts one or more rows of 1-bit compressed data from a buffer into an image that is maintained in its compressed format.

Syntax

Objective-C

C++

Java

[CLSCompliantAttribute(false)] 
public void SetRowCompressed( 
   byte[] workBuffer, 
   ushort[] runBuffer, 
   int runBufferOffset, 
   int row, 
   int lines 
)

<CLSCompliantAttribute(False)> 
Public Overloads Sub SetRowCompressed( _ 
   ByVal workBuffer() As Byte, _ 
   ByVal runBuffer() As UShort, _ 
   ByVal runBufferOffset As Integer, _ 
   ByVal row As Integer, _ 
   ByVal lines As Integer _ 
)

- (BOOL)setRowCompressed:(unsigned char *)workBuffer  
               runBuffer:(const unsigned short *)runBuffer  
                     row:(NSUInteger)row  
                   lines:(NSUInteger)lines  
                   error:(NSError **)error

public void setRowCompressed( 
  byte[] workBuffer,  
  short[] runBuffer,  
  int runBufferOffset,  
  int row,  
  int lines 
)

[CLSCompliantAttribute(false)] 
public: 
void SetRowCompressed(  
   array<byte>^ workBuffer, 
   array<ushort>^ runBuffer, 
   int runBufferOffset, 
   int row, 
   int lines 
)

Parameters

workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. The size of this buffer should be the same as the image's BytesPerLine property. Pass a null reference to runBuffer if you do not want to use a work buffer.

runBuffer
Input buffer, which contains 1-bit compressed image data.

runBufferOffset
Offset into runBuffer where the set operation should start.

row
Number of the first row to update.

lines
Number of rows to update.

Remarks

This method is available in the (Document/Medical only) Toolkits.

This method is useful for working with 1-bit images that are loaded in their compressed formats for faster loading and display.

For more information, refer to Speeding Up 1-Bit Documents.

Example

For an example, refer to GetRowCompressed.

Requirements

Target Platforms